/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package org.erossi.pigest.model.documento;

import java.util.Calendar;
import java.util.HashSet;
import java.util.Set;

import org.erossi.common.model.GenericBean;
import org.erossi.common.util.AppCtx;
import org.erossi.pigest.model.soggetto.Soggetto;

/**
 * 'Documento' class: bean che rappresenta l'entità documento
 *
 * @author erossi
 * @version Sep 17, 2008
 */
public class Documento extends GenericBean {

  private static final long serialVersionUID = 1L;

  private Boolean aperto;
  private Soggetto mittente;
  private Soggetto destinatario;
  private TipoDocumento tipo;
  private Calendar dataDocumento;
  private Calendar dataCarico;
  private String descrizione;
  private String note;
  private Set<RigaDocumento> righe;
  
  /**
   * Crea una nuova istanza della classe
   */
  public Documento() {
    
    aperto = null;
    mittente = null;
    destinatario = null;
    tipo = null;
    dataDocumento = null;
    dataCarico = null;
    descrizione = null;
    note = null;
    righe = new HashSet<RigaDocumento>();
    
  }
  
  /**
   * Aggiunge una riga all'insieme delle righe
   *   cui questo documento é associato.
   *   
   * @param riga la riga di documento da aggiungere all'elenco
   */
  public void aggiungiRiga(RigaDocumento riga) {
    
    righe.add(riga);
    riga.setDocumento(this);
    
  }
  
  /**
   * Verifica l'uguaglianza fra due oggetti.
   * 
   * <p>
   *   Nel confronto vengono verificati gli attributi significativi del bean
   *   {@link org.erossi.pigest.model.documento.Documento}, ovvero sono esclusi quelli che 
   *   appartengono al bean generico {@link org.erossi.common.model.GenericBean}
   *   che il primo estende.
   * </p>
   * <p>
   *   Sono esclusi dalla verifica gli attributi che costituiscono le associazioni/chiavi esterne.
   * </p>
   * <p>
   *   L'uguaglianza verificata é quindi quella <b>semantica</b>.
   * </p>
   * 
   * @param o l'oggetto di cui verificare l'uguaglianza
   */
  public boolean equals (Object o) {

    if (o == null) return false;
    if (!(o instanceof Documento)) return false;
    if (this == o) return true;  
    
    boolean equals = false;
    
    Documento d = (Documento) o;
    
    if (super.nullSafeEquals(d.getAperto(), this.getAperto())) {
      if (super.nullSafeEquals(d.getDataDocumento(), this.getDataDocumento())) {
        if (super.nullSafeEquals(d.getDataCarico(), this.getDataCarico())) {
          if (super.nullSafeEquals(d.getDescrizione(), this.getDescrizione())) {
            if (super.nullSafeEquals(d.getNote(), this.getNote())) {
              equals = true;
            }
          }
        }
      }
    }
    
    return equals;
    
  }
  
  /**
   * Calcola l'hash per l'oggetto corrente.
   * 
   * <p>
   *   L'hash dell'oggetto é calcolato come somma degli hash dei suoi attributi,
   *   esclusi quelli che appartengono al bean generico 
   *   {@link org.erossi.common.model.GenericBean}.
   * </p>
   * <p>
   *   Sono esclusi dalla verifica gli attributi che costituiscono le associazioni/chiavi esterne.
   * </p>
   * 
   * @return l'hash corrispondente all'oggetto corrente
   */
  public int hashCode() {
    
    int hashCode = 0;
    
    if (this.getAperto() != null) {hashCode += this.getAperto().hashCode();}
    if (this.getDataDocumento() != null) {hashCode += this.getDataDocumento().hashCode();}
    if (this.getDataCarico() != null) {hashCode += this.getDataCarico().hashCode();}
    if (this.getDescrizione() != null) {hashCode += this.getDescrizione().hashCode();}
    if (this.getNote() != null) {hashCode += this.getNote().hashCode();}
    
    return hashCode;
   
  }
  
  /**
   * Imposta il valore dell'attributo 'righe'
   * 
   * <p>
   *   Il metodo non gestisce la biunivocità della relazione. Utilizzare il metodo
   *   {@link org.erossi.pigest.model.documento.Documento#aggiungiRiga(RigaDocumento)},
   *   che garantisce la corretta associazione biunivoca fra le entità.
   * </p>
   * 
   * @param righe il valore dell'attributo 'righe'
   */
  public void setRighe(Set<RigaDocumento> righe) {
    this.righe = righe;
  }

  /**
   * Ritorna una rappresentazione sotto forma di 
   *   stringa dell'oggetto.
   * 
   * @return una stringa che rappresenta l'oggetto
   */
  public String toString() {

    String toString = new String();
    toString = this.getClass().getName();
    
    toString += AppCtx.printDebug("super", super.toString());
    toString += AppCtx.printDebug("aperto", aperto);
    toString += AppCtx.printDebug("dataDocumento", dataDocumento);
    toString += AppCtx.printDebug("dataCarico", dataCarico);
    toString += AppCtx.printDebug("descrizione", descrizione);
    toString += AppCtx.printDebug("note", note);
    
    return toString;

  }
  
  /**
   * Restituisce il valore dell'attributo 'aperto'
   * @return il valore dell'attributo aperto
   */
  public Boolean getAperto() {
    return this.aperto;
  }

  /**
   * Imposta il valore dell'attributo 'aperto'
   * @param aperto il valore dell'attributo 'aperto'
   */
  public void setAperto(Boolean aperto) {
    this.aperto = aperto;
  }

  /**
   * Restituisce il valore dell'attributo 'mittente'
   * @return il valore dell'attributo mittente
   */
  public Soggetto getMittente() {
    return this.mittente;
  }

  /**
   * Imposta il valore dell'attributo 'mittente'
   * @param mittente il valore dell'attributo 'mittente'
   */
  public void setMittente(Soggetto mittente) {
    this.mittente = mittente;
  }

  /**
   * Restituisce il valore dell'attributo 'destinatario'
   * @return il valore dell'attributo destinatario
   */
  public Soggetto getDestinatario() {
    return this.destinatario;
  }

  /**
   * Imposta il valore dell'attributo 'destinatario'
   * @param destinatario il valore dell'attributo 'destinatario'
   */
  public void setDestinatario(Soggetto destinatario) {
    this.destinatario = destinatario;
  }

  /**
   * Restituisce il valore dell'attributo 'dataDocumento'
   * @return il valore dell'attributo dataDocumento
   */
  public Calendar getDataDocumento() {
    return this.dataDocumento;
  }

  /**
   * Imposta il valore dell'attributo 'dataDocumento'
   * @param dataDocumento il valore dell'attributo 'dataDocumento'
   */
  public void setDataDocumento(Calendar dataDocumento) {
    this.dataDocumento = dataDocumento;
  }

  /**
   * Restituisce il valore dell'attributo 'dataCarico'
   * @return il valore dell'attributo dataCarico
   */
  public Calendar getDataCarico() {
    return this.dataCarico;
  }

  /**
   * Imposta il valore dell'attributo 'dataCarico'
   * @param dataCarico il valore dell'attributo 'dataCarico'
   */
  public void setDataCarico(Calendar dataCarico) {
    this.dataCarico = dataCarico;
  }

  /**
   * Restituisce il valore dell'attributo 'note'
   * @return il valore dell'attributo note
   */
  public String getNote() {
    return this.note;
  }

  /**
   * Imposta il valore dell'attributo 'note'
   * @param note il valore dell'attributo 'note'
   */
  public void setNote(String note) {
    this.note = note;
  }

  /**
   * Restituisce il valore dell'attributo 'descrizione'
   * @return il valore dell'attributo descrizione
   */
  public String getDescrizione() {
    return this.descrizione;
  }

  /**
   * Imposta il valore dell'attributo 'descrizione'
   * @param descrizione il valore dell'attributo 'descrizione'
   */
  public void setDescrizione(String descrizione) {
    this.descrizione = descrizione;
  }

  /**
   * Restituisce il valore dell'attributo 'tipo'
   * @return il valore dell'attributo tipo
   */
  public TipoDocumento getTipo() {
    return this.tipo;
  }

  /**
   * Imposta il valore dell'attributo 'tipo'
   * @param tipo il valore dell'attributo 'tipo'
   */
  public void setTipo(TipoDocumento tipo) {
    this.tipo = tipo;
  }

  /**
   * Restituisce il valore dell'attributo 'righe'
   * @return il valore dell'attributo righe
   */
  public Set<RigaDocumento> getRighe() {
    return this.righe;
  }
  
}

